/*******************************************************************************
 * This file is part of blueprint4j www.blueprint4j.org.
 * 
 *     blueprint4j is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * 
 *     blueprint4j is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 * 
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with blueprint4j. If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package blueprint4j.db;

import java.sql.ResultSet;
import java.sql.SQLException;
import java.text.SimpleDateFormat;
import java.util.Date;

import blueprint4j.utils.BindException;
import blueprint4j.utils.BindTimeInterface;
import blueprint4j.utils.Log;

public class FieldTime extends Field implements BindTimeInterface {
    private static String time_format_description = "HH:mm:ss";
    public static SimpleDateFormat time_format = new SimpleDateFormat(time_format_description);
    
    /**
     * public FieldTime( String p_name, String p_description, boolean p_key_field)
     *
     * Name: Name of field -> equivalent to table.field_name
     * Description: Description of field
     * key_field: Is this field a key field in the table (index field)
     */
    public FieldTime( String p_name, int p_field_type ,String p_description,String time_format_description,Entity entity ) {
        super( p_name,p_field_type,p_description,entity );
        if (time_format_description != null) {
            this.time_format = new SimpleDateFormat(time_format_description);
            this.time_format_description = time_format_description;
        }
    }
    
    public FieldTime( String p_name, int p_field_type ,String p_description,Entity entity ) {
        this(p_name,p_field_type,p_description,null,entity);
    }
    
    public Field newInstance(Entity entity) {
        return new FieldTime(getName(),getFieldType(),getDescription(),entity);
    }
    
    protected void setFieldValue( ResultSet result_set )
    throws DataException {
        try {
            java.sql.Time time = result_set.getTime( getName() );
            if (time !=null) {
                setObject( new Date(time.getTime() ));
            } else {
                setObject( null );
            }
        } catch ( SQLException se ) {
            throw new DataException( "Can not retrieve '" + getName() + "' "+se.getMessage() );
        }
    }
    
    public Date get() {
        return (Date) getObject();
    }
    
    public void set(Date value){
        setObject(value);
    }
    
    /**
     * Return data in a suitable SQL format
     */
    public String getSQLValue() {
        if (getObject() == null) {
            return "null";
        }
        return entity.getConnection().getDataBaseUtils().convertDateTimeToSQLString(get());
    }
    
    public String toString() {
        if (getObject() == null) {
            return null;
        }
        return time_format.format(get());
    }
    
    /**
     * An overloaded equals method that only accepts the correct type
     */
    public boolean equals(Date value) {
        return get().equals(value);
    }
    
    public Object getPreparedStatementObject()
    throws DataException {
        if (getObject() == null) return null;
        return new java.sql.Timestamp(get().getTime());
    }
    
    public String getSerializable() throws BindException {
        if (getObject() == null) {
            return "null";
        }
        return time_format.format(get());
    }
    
    public void setSerializable(String p_value) throws BindException {
        if ("null".equalsIgnoreCase(p_value)) {
            setObject(null);
        } else {
            try {
                setObject(time_format.parse(p_value));
            } catch(Exception e) {
                Log.debug.out(e);
            }
        }
    }
    
    public String getTimeFormatDescription() {return time_format_description;}
    
    public SimpleDateFormat getTimeFormat() {return time_format;}
    
    
}
